//--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
// Copyright 2012 Microsoft Corporation. All Rights Reserved
// Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.   
// You may obtain a copy of the License at
// http://www.apache.org/licenses/LICENSE-2.0
// Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
//--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

namespace Preflight.Verifications
{
    using System.ComponentModel.Composition.Primitives;

    /// <summary>
    /// Verification builder uses MEF to build verifications that inherit from VerificationBase
    /// </summary>
    /// <remarks>
    /// For a given description (T), this builder expects that there is one and only one VerificationBase of T in all provided catalogs.
    /// By default, the catalog loaded is DirectoryCatalog using the AppDomain's application base directory
    /// </remarks>
    public interface IVerificationBuilder
    {
        /// <summary>
        /// Adds additional catalogs to use when composing verifications
        /// </summary>
        /// <param name="catalog">part catalog</param>
        void AddVerificationCatalog(ComposablePartCatalog catalog);

        /// <summary>
        /// Builds a verification
        /// </summary>
        /// <typeparam name="TDescription">Description type</typeparam>
        /// <param name="description">Description value</param>
        /// <returns>Verification instance</returns>
        IVerification BuildVerification<TDescription>(TDescription description) where TDescription : VerificationDescription;

        /// <summary>
        /// Builds a verification. Will return a always-failing verification with the exception if VerificationBuilder cannot build the verification.
        /// </summary>
        /// <typeparam name="TDescription">Description type</typeparam>
        /// <param name="description">Description value</param>
        /// <returns>Verification instance</returns>
        IVerification SafeBuildVerification<TDescription>(TDescription description) where TDescription : VerificationDescription;
    }
}
